Apple Guide is the GM version of the system extension; it is distributed as part of System 7.5.
<Coach Mark> "Apple Guide Extension"
<End Panel>
<End Sequence>
<Define Sequence> "What is Apple Guide Debug?"
<Define Panel> "AG Debug 1"
Apple Guide Debug is an alternate version of the Apple Guide system extension that allows you to debug guide files with the Guide Maker diagnose utility.
This version is intended for use only by authors using Guide Maker; it provides no additional benefit to end users.
<Coach Mark> "Apple Guide Debug"
<End Panel>
<End Sequence>
<Define Sequence> "How do I install Apple Guide Debug?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Install AG Debug 1"
Apple Guide Debug replaces the Apple Guide system extension installed in System 7.5.
To use Apple Guide Debug, install it in the System Folder on your startup disk and remove the standard version of the Apple Guide system extension.
<End Panel>
<Define Panel> "Install AG Debug 2"
<Format> "Tag"
Do This
<Format> "Body"
Drag the Apple Guide Debug file onto the System Folder on your startup disk.
<Coach Mark> "Apple Guide Debug"
<End Panel>
<Define Panel> "Install AG Debug 3"
<Format> "Tag"
Do This
<Format> "Body"
Drag the Apple Guide system extension from the System Folder on your startup disk to the Trash.
<Coach Mark> "Apple Guide Replaced"
<End Panel>
<Define Panel> "Install AG Debug 4"
Apple Guide Debug will be available after you restart your computer.
Guide Maker is an authoring tool for creating guide files. It includes utilties for:
• building guide files
• testing Look For search phrases
• diagnosing and debugging guide files
• converting Windows Help RTF files
• localizing guide files
This GM version includes many bug fixes and usability enhancements.
<Coach Mark> "Guide Maker"
<End Panel>
<Define Panel> "Guide Maker 2"
The “Guide Maker-Read Me” file contains late-breaking errata and important tips for using Guide Maker most effectively.
<Coach Mark> "Guide Maker - Read Me"
<End Panel>
<End Sequence>
<Define Sequence> "How do I install Guide Maker?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Install GM 1"
Guide Maker is an application that can be installed anywhere on a local disk.
<End Panel>
<Define Panel> "Install GM 2"
<Format> "Tag"
Do This
<Format> "Body"
Drag the Guide Maker application into any folder on a local disk.
<Coach Mark> "Guide Maker"
<End Panel>
<Define Panel> "Install GM 3"
If you have not already done so, you should install Apple Guide Debug and the Espy Fonts to make working with Guide Maker easier.
Select any additional items that you'd also like to install now:
<Checkbox> "Apple Guide Debug", FALSE, "How do I install Apple Guide Debug?", , ,APPLEGUIDE
<Checkbox> "Espy Fonts", FALSE, "How do I install the Apple Guide fonts?", , ,APPLEGUIDE
<End Panel>
<Define Panel> "Install GM 4"
Guide Maker is now ready to use. Open the application to get started.
<End Panel>
<End Sequence>
##### Documentation folder #####
<Define Sequence> "What is in the “Documentation” folder?"
<Define Panel> "Documentation 1"
The “Documentation” folder contains complete documentation for Apple Guide and Guide Maker in Apple DocViewer format.
Major sections include:
• Apple Guide Introduction
• Authoring Guidelines and Tips
• Guide Maker User’s Guide
• Apple Guide API
• Guide Script Command Reference
• Guide Script Command Summary
<Coach Mark> "Documentation Fldr"
<End Panel>
<End Sequence>
##### Fonts folder #####
<Define Sequence> "What is in the “Fonts” folder?"
<Define Panel> "Fonts 1"
The “Fonts” folder contains bitmapped versions of the recommended Apple Guide fonts:
• Espy Serif
• Espy Serif Bold
• Espy Sans
• Espy Sans Bold
These fonts have been designed for on-screen display and are built into Apple Guide.
Install these fonts in your system for use when authoring guide files.
<Coach Mark> "Espy Font Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "How do I install the Apple Guide fonts?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Install AG Fonts 1"
The Espy font files should be installed in the Fonts folder on your startup disk.
<End Panel>
<Define Panel> "Install AG Fonts 2"
<Format> "Tag"
Do This
<Format> "Body"
Drag the Espy font files onto the System Folder on your startup disk.
<Coach Mark> "Espy Font Files"
<End Panel>
<Define Panel> "Install AG Fonts 3"
If your word processing application is already open, quit and relaunch it to make the new fonts available.
<End Panel>
<End Sequence>
##### Example Guide Files #####
<Define Sequence> "Example Guide Files overview"
<Define Panel> "Example GF Overview 1"
The “Example Guide Files” folder contains all the guide files shipped with System 7.5.
Browse these guide files for ideas about how to use Apple Guide effectively.
<Coach Mark> "Example Guide File Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is in the “Example Guide Files” folder?"
<Define Panel> "Example GF 1"
The “Example Guide Files” folder contains all the guide files shipped with System 7.5.
Browse these guide files for ideas about how to use Apple Guide effectively.
<Coach Mark> "Example Guide File Files"
<End Panel>
<Define Panel> "Example GF 2"
The “SYM Files” folder contains symbol (.SYM) files for many of the example guide files to facilitate examining them with the Guide Maker diagnose utility.
<Coach Mark> "Example SYM Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "How do I explore the example guide files?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Explore GF 1"
You can easily explore the example guide files by opening them in Guide Maker's diagnose utility.
<Coach Mark> "Example Guide File Files"
<End Panel>
<Define Panel> "Explore GF 2"
<Format> "Tag"
Do This
<Format> "Body"
Move the .SYM file for the guide file that you'll be exploring into the same folder as the guide file.
Having the .SYM file located in the same folder will make navigating through the guide file easier.
<Coach Mark> "Example SYM Files"
<End Panel>
<Define Panel> "Explore GF 3"
<Format> "Tag"
Do This
<Format> "Body"
Open the Guide Maker application.
<Coach Mark> "Guide Maker"
<End Panel>
<Define Panel> "Explore GF 4"
<Format> "Tag"
Do This
<Format> "Body"
Open the File menu and choose Open, then select the guide file to explore.
<Coach Mark> "GM File Open"
<End Panel>
<Define Panel> "Explore GF 5"
<Format> "Tag"
Do This
<Format> "Body"
Open the Utilities menu and choose Diagnose to open the Guide Maker diagnose utility.
<Coach Mark> "GM Utility Diagnose"
<End Panel>
<Define Panel> "Explore GF 6"
<Format> "Tag"
Do This
<Format> "Body"
Click on the Startup button, then browse through the guide file.
<Coach Mark> "GM Diagnose Startup"
<End Panel>
<Define Panel> "Explore GF 7"
You can also use the Go Panel and Go Sequence buttons to quickly navigate to specific parts of the guide file that you want to see.
<Coach Mark> "GM Diagnose Go Buttons"
<End Panel>
<End Sequence>
##### Example Source Files #####
<Define Sequence> "Example Source Files Overview"
<Define Panel> "Example SF Overview 1"
The “Example Source Files” folder contains the Guide Script source files (in Microsoft Word format) used to create the example guide files.
Study these source files for examples of how to use the Guide Script command language effectively.
<Coach Mark> "Example Source File Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is in the “Example Source Files” folder?"
<Define Panel> "Example SF 1"
The “Example Source Files” folder contains the Guide Script source files (in Microsoft Word format) used to create the example guide files.
Study these source files for examples of how to use the Guide Script command language effectively.
<Coach Mark> "Example Source File Files"
<End Panel>
<Define Panel> "Example SF 2"
Each folder contains the complete set of source files needed to compile the example guide files included on this CD.
<Coach Mark> "Example Source File Set"
<End Panel>
<Define Panel> "Example SF 3"
The “Main” file in each set points to all of the other files that make up the set.
This type of file is called a “Build” file in Guide Maker.
<Coach Mark> "Example Source Main"
<End Panel>
<Define Panel> "Example SF 4"
The “Topics” file contains commands that define the outline of topics presented in the Topic Areas screen for this guide file.
Similarly, the “Index” file contains commands that define the Index screen, and the “Look For” file contains commands that control Look For searching.
<Coach Mark> "Example Source Topics"
<End Panel>
<Define Panel> "Example SF 5"
The “Panels” file contains commands that define the layout and content presented on each of the panels in the guide file.
Study this file to learn more about:
• placing elements on panels
• associating coach marks with panels
• linking AppleScripts to panels
<Coach Mark> "Example Source Panels"
<End Panel>
<Define Panel> "Example SF 6"
The “Coaches” file contains commands that define the coach marks used in the guide file.
<Coach Mark> "Example Source Coaches"
<End Panel>
<Define Panel> "Example SF 7"
The “Sequences” file contains commands that control the order in which panels are presented within each sequence (topic).
Study this file to learn more about using context checks and conditional functions to dynamically adapt the content presented when the guide file is used.
<Coach Mark> "Example Source Sequences"
<End Panel>
<End Sequence>
##### Standard Includes #####
<Define Sequence> "Standard Includes Overview"
<Define Panel> "SI Overview 1"
The “Standard Includes” folder contains a set of files that can be used as a starting point for building your own guide files.
These files contain the basic Guide Script commands and resources needed to create a guide file conforming to the Apple Guide human interface guidelines.
<Coach Mark> "Standard Includes Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is in the “Standard Includes” folder?"
<Define Panel> "Standard Includes 1"
The “Standard Includes” folder contains a set of files that can be used as a starting point for building your own guide files.
<Coach Mark> "Standard Includes Files"
<End Panel>
<Define Panel> "Standard Includes 2"
The “Standard Setup” file contains the basic Guide Script commands needed to create a guide file conforming to the Apple Guide human interface guidelines.
Edit this file to customize the standard command templates for your guide file. Most of the commands in this file can be used “as is,” but you'll want to change the <Help Menu>, <Balloon Menu Text>, and <Version> commands to reflect your application's name.
<Coach Mark> "Standard Includes Setup"
<End Panel>
<Define Panel> "Standard Includes 3"
The “Build File” file points to all of the related source files that define your guide file.
Edit this file to point to all of the source files for your guide file.
<Coach Mark> "Standard Includes Build"
<End Panel>
<Define Panel> "Standard Includes 4"
The “Content” file contains the actual content (text, graphics, QuickTime movies, and so on) that appears on the panels of your guide file.
Edit this file to define the content of your panels and sequences. As your guide file grows, it may be helpful to break the contents of this file into several smaller files. If you do so, be sure to update the “Build” file to point to all of the additional source files.
<Coach Mark> "Standard Includes Content"
<End Panel>
<Define Panel> "Standard Includes 5"
The “Standard Resources” file contains the resources needed to create a guide file conforming to the Apple Guide human interface guidelines.
It includes PICT graphics used in the standard navigation bar button defintions and external code module resources used by the context checks in Macintosh Guide.
You shouldn't need to change this file, but be sure to place a copy of it in the same folder as your other source files.
<Coach Mark> "Standard Includes Resources"
<End Panel>
<End Sequence>
<Define Sequence> "How do I use the “Standard Includes” files?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Use SI 1"
You can use the files in the “Standard Includes” folder as a starting point for quickly creating your won Guide Script source files.
<End Panel>
<Define Panel> "Use SI 2"
<Format> "Tag"
Do This
<Format> "Body"
Copy the files in the “Standard Includes” folder to a local disk.
<Coach Mark> "Standard Includes Files"
<End Panel>
<Define Panel> "Use SI 3"
<Format> "Tag"
Do This
<Format> "Body"
Edit the “Standard Setup” to customize the standard command templates for your guide file.
Most of the commands in this file can be used “as is,” but you'll want to change the <Help Menu>, <Balloon Menu Text>, and <Version> commands to reflect your application's name.
<Coach Mark> "Standard Includes Setup"
<End Panel>
<Define Panel> "Use SI 4"
<Format> "Tag"
Do This
<Format> "Body"
Edit the “Content” file, using Guide Script commands to define the content of your panels and sequences.
As your guide file grows, it may be helpful to break the contents of this file into several smaller files. If you do so, be sure to update the “Build” file to point to all of the additional source files.
<Coach Mark> "Standard Includes Content"
<End Panel>
<Define Panel> "Use SI 5"
<Format> "Tag"
Do This
<Format> "Body"
Edit the “Build File” file to point to all of the source files for your guide file.
It already points to the files to the standard files, but if you have created additional content files, be sure to update this file to point to all of the additional source files.
<Coach Mark> "Standard Includes Build"
<End Panel>
<Define Panel> "Use SI 6"
You're now ready to compile the “Build File” using the Guide Maker build utility.
<Coach Mark> "Guide Maker"
<End Panel>
<End Sequence>
##### Unsupported Goodies #####
<Define Sequence> "Unsupported Goodies Overview"
<Define Panel> "UG Overview 1"
The “Unsupported Goodies” folder contains a a collection of unsupported tools that may assist you when creating guide files.
Note that some items, including those in this folder, are not supported by Apple. Unsupported tools are provided to developers strictly “as is,” with no support or promises of future expansion or bug fixes. Be sure to read the Read Me file for each tool to determine whether you want to use it for your project.
<Coach Mark> "Unsupported Goodies Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is in the “Unsupported Goodies” folder?"
<Define Panel> "Unsupported Goodies 1"
The “Unsupported Goodies” folder contains a collection of unsupported tools that may assist you when creating guide files.
<Coach Mark> "Unsupported Goodies Files"
<End Panel>
<Define Panel> "Unsupported Goodies 2"
Coach Mark Assistant is a SuperCard™ application that helps build coach mark definitions and lets you test them on the fly.
<Coach Mark> "Unsupported Goodies CMA Fldr"
<End Panel>
<Define Panel> "Unsupported Goodies 3"
What's Your Sign is a system extension that helps you identify dialog item IDs in an active application.
<Coach Mark> "Unsupported Goodies WYS Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is Coach Mark Assistant?"
<Panel> "Unsupported Goodies 2"
<End Sequence>
<Define Sequence> "What is “What's Your Sign?” ?"
<Panel> "Unsupported Goodies 3"
<End Sequence>
<Define Sequence> "How do I install Coach Mark Assistant?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Install CMA 1"
Coach Mark Assistant is an application that can be installed anywhere on a local disk.
<End Panel>
<Define Panel> "Install CMA 2"
<Format> "Tag"
Do This
<Format> "Body"
Drag the “Coach Mark Assistant” application into any folder on a local disk.
<Coach Mark> "Unsupported Goodies CMA"
<End Panel>
<Define Panel> "Install CMA 3"
<Format> "Tag"
Do This
<Format> "Body"
Drag the “Target” guide file into the same folder as the Coach Mark Assistant application.
<Coach Mark> "Unsupported Goodies Target"
<End Panel>
<Define Panel> "Install CMA 4"
Coach Mark Assistant is now ready to use. Open the application to get started.
<End Panel>
<End Sequence>
<Define Sequence> "How do I install “What's Your Sign?” ?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Install WYS 1"
<Format> "Tag"
Do This
<Format> "Body"
Drop the “What's Your Sign?” system extension onto the System Folder on your startup disk.
<Coach Mark> "Unsupported Goodies WYS"
<End Panel>
<Define Panel> "Install WYS 2"
What's Your Sign? will be available after you restart your computer.
<Define Sequence> "What is in the “Developer Articles” folder?"
<Define Panel> "Dev Articles 1"
The “Developer Articles” folder contains previously published articles describing how to integrate Apple Guide with your application and write external modules that extend Apple Guide’s functionality.
<Coach Mark> "Developer Articles"
<End Panel>
<End Sequence>
##### APISample #####
<Define Sequence> "APISample Overview"
<Define Panel> "MG Overview 1"
APISample is an example application that illustrates how to seamlessly integrate Apple Guide features into your interface.
The application and its guide file, as well as all source files are included in this folder.
<Coach Mark> "APISample Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "What is APISample?"
<Define Panel> "APISample 1"
APISample is an example application that illustrates how to seamlessly integrate Apple Guide features into your interface.
<Coach Mark> "APISample Fldr"
<End Panel>
<Define Panel> "APISample 2"
The “APISampleCW” folder contains a Code Warrior version of the application and its guide file, as well as all source files for building APISample.
<Coach Mark> "APISample CW"
<End Panel>
<Define Panel> "APISample 3"
The “APISampleMPW” folder contains an MPW version of the application and its guide file, as well as all source files for building APISample.
<Coach Mark> "APISample MPW"
<End Panel>
<Define Panel> "APISample 4"
The “APISample - Read Me” file contains important instructions about installing, operating, and building APISample.
<Coach Mark> "APISample Read Me"
<End Panel>
<End Sequence>
<Define Sequence> "How do I install APISample?"
<Panel> "APISample 4"
<End Sequence>
<Define Sequence> "How do I use APISample?"
<Panel> "APISample 4"
<End Sequence>
<Define Sequence> "How do I build APISample?"
<Panel> "APISample 4"
<End Sequence>
##### Context Check Modules #####
<Define Sequence> "What is in the “Context Check Modules” folder?"
<Define Panel> "Context Check 1"
The “Context Check Modules” folder contains the source files for the context-checking external modules used in the example guide files included in this kit.
Study these files to learn more about how to write external modules for context checking.
<Coach Mark> "Context Check Fldr"
<End Panel>
<End Sequence>
##### Interfaces #####
<Define Sequence> "What is in the “Interfaces” folder?"
<Define Panel> "Interfaces 1"
The “Interfaces” folder contains Apple Guide interface files in both old and ETO formats.
<Coach Mark> "Interfaces Fldr"
<End Panel>
<End Sequence>
##### AGFile Library #####
<Define Sequence> "What is in the “AGFile Library” folder?"
<Define Panel> "AGFile 1"
The “AGFile Library” folder contains the AGFile header and library files.
<Coach Mark> "AGFile Fldr"
<End Panel>
<End Sequence>
##### RenoDB Library #####
<Define Sequence> "What is in the “RenoDB Library” folder?"
<Define Panel> "RenoDB 1"
The “RenoDB Library” folder contains the read-write software library for guide files, a header, and documentation.
<Coach Mark> "RenoDB Fldr"
<End Panel>
<Define Panel> "RenoDB 2"
The RenoDB header and documentation are provided “as is” to give you an overview of how RenoDB works. Currently these materials are very rough and are known to contain errors that need updating.
Although you will not be able to get RenoDB to work correctly based on this material, we wanted to provide as much information about RenoDB as is currently available.
<Coach Mark> "RenoDB Files"
<End Panel>
<End Sequence>
##### OpenGuide #####
<Define Sequence> "What is OpenGuide?"
<Define Panel> "OpenGuide 1"
OpenGuide is an AppleScript applet that opens guide files from the Finder (outside of the host application's context).
This applet replaces the OpenDB application.
<Coach Mark> "OpenGuide Fldr"
<End Panel>
<End Sequence>
<Define Sequence> "How do I open guide files?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Use OpenGuide 1"
<Format> "Tag"
Do This
<Format> "Body"
Drop a guide file on top of the OpenGuide applet to open it.
<Coach Mark> "OpenGuide File"
<End Panel>
<End Sequence>
##### AGStart #####
<Define Sequence> "What is AGStart?"
<Define Panel> "AGStart 1"
The AGStart Scripting Addition is an AppleScript scripting addition that allows you to open guide files using AppleScript.
You can then use Apple Guide’s Apple events to open guide files, quit Apple Guide, and so on.
<Define Sequence> "How do I learn what Apple Guide can do?"
<Sequence Prompt Set> "How do I prompts"
<Define Panel> "Learn Apple Guide 1"
You can learn more about what Apple Guide can do by reading about its features and browsing through the example guide files found on the AppleGuide CD.
<End Panel>
<Define Panel> "Learn Apple Guide 2"
<Format> "Tag"
Do This
<Format> "Body"
Read the “Introduction to Apple Guide” chapter of the Apple Guide documentation.
<Coach Mark> "Documentation File"
<End Panel>
<Define Panel> "Learn Apple Guide 3"
<Format> "Tag"
Do This
<Format> "Body"
Browse through the example guide files shipped with System 7.5.
<Coach Mark> "Example Guide File Files"
<End Panel>
<End Sequence>
<Define Sequence> "How do I begin authoring guide files?"
<Sequence Prompt Set> "How do I prompts"
<Panel> "Authoring Folder 1"
<Define Panel> "Begin Authoring 2"
<Format> "Tag"
Do This
<Format> "Body"
Read the “Authoring Guidelines and Tips” and “Guide Maker User’s Guide” chapters of the Apple Guide documentation.
Work through the “QuickStart” example.
<Coach Mark> "Documentation File"
<End Panel>
<Insert Sequence> "How do I use the “Standard Includes” files?"
<End Sequence>
<Define Sequence> "How do I integrate Apple Guide into my application?"
<Define Panel> "Integrate Apple Guide 1"
You can learn about integrating Apple Guide into your application by reading the developer articles included on the Apple Guide CD and exploring the APISample example application.
<End Panel>
<Define Panel> "Integrate Apple Guide 2"
<Format> "Tag"
Do This
<Format> "Body"
Read the “develop 18” article for an overview of the integration options.
<Coach Mark> "develop 18"
<End Panel>
<Define Panel> "Integrate Apple Guide 3"
<Format> "Tag"
Do This
<Format> "Body"
Read the “Apple Guide API” chapter of the Apple Guide documentation.
<Coach Mark> "Documentation File"
<End Panel>
<Insert Sequence> "APISample Overview"
<End Sequence>
<Define Sequence> "How do I support context checks in my application?"
<Define Panel> "Internal CC 1"
You can learn about supporting context checks in your application by reading the developer articles included on the Apple Guide CD and exploring the APISample example application.
<End Panel>
<Panel> "Integrate Apple Guide 2"
<Insert Sequence> "APISample Overview"
<End Sequence>
<Define Sequence> "How do I create context check external modules?"
<Define Panel> "External CC 1"
You can learn about providing context checks through external modules by reading the developer articles included on the Apple Guide CD and exploring the example context check source files.
<End Panel>
<Define Panel> "External CC 2"
<Format> "Tag"
Do This
<Format> "Body"
Read the “MacHack” article for an overview of external code modules.
<Coach Mark> "MacHack"
<End Panel>
<Insert Sequence> "What is in the “Context Check Modules” folder?"
